<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
</head>
<title>Wt Installation</title>
<body>
<h1>Wt Installation instructions for Windows</h1>

This page lists the instructions for building and installing Wt on Windows.
It is organized in 3 sections:
<ul>
<li>Requirements</li>
<li>Building and installing the library</li>
<li>Trying the examples (or your own Wt application)</li>
<li>LibreJS Compliance</li>
</ul>

<h2>Requirements</h2>

<p>
Wt for Windows uses the built-in web server connector or the ISAPI connector.
The fastcgi connector is not supported. The built-in web server is more
convenient during development and is easier to setup than the ISAPI connector.
To use the built-in server, you have to link your projects against libwt
and libwthttp. To use the ISAPI connector, you have to link to libwtisapi
instead of libwthttp.</p>

<p>Requirements:
<ul>
  <li>Microsoft Visual Studio C++ 2005 or newer. Wt and its dependencies also
      build on the Express Edition, which is free (as in beer) to use.
  <li>CMake cross-platform build system (www.cmake.org): cmake-2.6.x,
      Windows version (2.8 or newer recommended).</li>
  <li>Boost 1.46.1 (or later; a recent version is recommended)</li>
</ul>
</p>

<p>Additional and optional requirements for some of the examples
<ul>
<li>For https support: OpenSSL, version 0.9.8d or newer.</li>
<li>To compress traffic: zlib 1.2.3</li>
<li>Postgres, mysql, firebird client libraries for Dbo database backends</li>
<li><a href="http://libharu.org/">Haru Free PDF Library</a>, which is used to
provide support for rendering PDF (WPdfImage, WPdfRenderer).</li>
<li><a href="http://www.graphicsmagick.org/">GraphicsMagick</a>, for
supporting painting to raster images (PNG, GIF, ...) (WRasterImage).</li>
</ul>
</p>

<p>
We stronly recommend to use libraries which are all built using the same
compiler and the same runtime configuration (/MT, /MD, /MTd
or /MDd) to avoid incompatibilities with the C runtime libraries. Mixing
CRTs is NOT recommended, the <a href="http://www.zlib.net/DLL_FAQ.txt">zlib
DLL FAQ</a> clearly explains why and what you should do about it (in
short: use prebuilt libraries for the exact same compiler as you use, and
if those are not available, rebuild the dependency libraries from the sources).
</p>

<hr />

<h2>Step by step instructions to build and install the Wt library</h2>

Up to date instructions are located on the Wt wiki page:
<a href="http://redmine.emweb.be/projects/wt/wiki/Installing_Wt_on_MS_Windows">Installing Wt on MS Windows</a>

Instructions on how to use the ISAPI connector for deployment under IIS are
also available on the wiki page:
<a href="http://redmine.emweb.be/projects/wt/wiki/ISAPI_on_Microsoft_IIS">ISAPI on Microsoft IIS</a>

<h2>Trying the examples (or your own Wt application) using wthttpd</h3>

<h4>1. Run the example in the MSVC IDE </h4>

Right-click on the example project you want to run, and select 'Properties'.
In Configuration Properties->Debugging, set the Command Arguments to
<pre>
--http-address=0.0.0.0 --http-port=8080 --deploy-path=/hello --docroot=.
</pre>

<p>
This will start a httpd server listening on all local interfaces, on
port 8080, and you may browse the example at <a
href="http://127.0.0.1:8080/hello">http://127.0.0.1:8080/hello</a></p>

<p>
Examples that need extra files to run, should be executed from their source
directory in order to find their dependency files (icons, css files, etc.
Watch for 404 errors in Wt's output). To do so, set the 'Working directory'
for the example to wt-x.y.z/examples/ExampleName. Some examples (e.g. the
wt home page) need the 'resources' directory to work correctly. Copy
the wt-2.x.x/resources to the example's source directory to solve this
problem. Other examples (such as the Charts example) may require the
installation of ExtJs. See the Wt reference manual for more information
on how to obtain and install ExtJs. 

<p>
These are all the command-line options that are available (run the examples
with --help to see the most recent list of available options):

<pre>
General options:
  -h [ --help ]              produce help message
  -t [ --threads ] arg (=10) number of threads
  --docroot arg              document root for static files
  --no-compression           do not compress dynamic text/html and text/plain 
                             responses
  --deploy-path arg (=/)     location for deployment

HTTP server options:
  --http-address arg    IPv4 (e.g. 0.0.0.0) or IPv6 Address (e.g. 0::0)
  --http-port arg (=80) HTTP port (e.g. 80)

HTTPS server options:
  --https-address arg     IPv4 (e.g. 0.0.0.0) or IPv6 Address (e.g. 0::0)
  --https-port arg (=443) HTTPS port (e.g. 443)
  --ssl-certificate arg   SSL server certificate chain file
                          e.g. "/etc/ssl/certs/vsign1.pem"
  --ssl-private-key arg   SSL server private key file
                          e.g. "/etc/ssl/private/company.pem"
  --ssl-tmp-dh arg        File for temporary Diffie-Hellman parameters
                          e.g. "/etc/ssl/dh512.pem"
</pre>
</p>

<hr />

<h2>LibreJS Compliance</h2>

<p>To make your website to be LibreJS compliant, simply copy
src/web/skeleton/libreJS_sources.example.txt into the directory
containing the *.wt executable as libreJS_sources.txt; then edit it
to include one or more @source lines with URLs at which your
non-minified javascript sources can be downloaded.  One such line
should point to the entire Wt sources because some of the inline
scripts have no other corresponding source.</p>
e.g.
<code>
$ cp src/web/skeleton/libreJS_sources.example.txt /path/to/my-site/libreJS_sources.txt
$ cat /path/to/my-site/libreJS_sources.txt
  @source - https://your-site.net/sources/wt/
  @source - https://your-site.net/sources/your-custom.js
</code>

</body>
</html>
